//
// * Copyright (c) 2002-2009 "Neo Technology,"
// *     Network Engine for Objects in Lund AB [http://neotechnology.com]
// *
// * This file is part of Neo4j.
// * 
// * Neo4j is free software: you can redistribute it and/or modify
// * it under the terms of the GNU Affero General Public License as
// * published by the Free Software Foundation, either version 3 of the
// * License, or (at your option) any later version.
// * 
// * This program is distributed in the hope that it will be useful,
// * but WITHOUT ANY WARRANTY; without even the implied warranty of
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// * GNU Affero General Public License for more details.
// * 
// * You should have received a copy of the GNU Affero General Public License
// * along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
namespace org.neo4j.kernel.impl.persistence
{

///
/// <summary> * The IdGenerator is responsible for generating unique ids for entities in the
/// * Neo. The IdGenerator is configured via the <seealso cref="IdGeneratorModule"/>.
/// * <P>
/// * The IdGenerator must be loaded after its designated
/// * <seealso cref="IdGeneratorModule#setPersistenceSource persistence source"/> during
/// * startup.
/// * <P> </summary>
/// 
	public class IdGenerator
	{
		internal IdGenerator()
		{
		}

	// the persistence source used to store the HIGH keys
		private PersistenceSource persistenceSource = null;

///    
///     <summary> * Returns the next unique ID for the entity type represented by 
///     * <CODE>clazz</CODE>. </summary>
///     * <returns> the next ID for <CODE>clazz</CODE>'s entity type </returns>
///     
		public virtual int nextId<T1>(System.Type<T1> clazz)
		{
			return getPersistenceSource().nextId(clazz);
		}

		public virtual long getHighestPossibleIdInUse<T1>(System.Type<T1> clazz)
		{
			return getPersistenceSource().getHighestPossibleIdInUse(clazz);
		}

		public virtual long getNumberOfIdsInUse<T1>(System.Type<T1> clazz)
		{
			return getPersistenceSource().getNumberOfIdsInUse(clazz);
		}

///    
///     <summary> * Configures the IdGenerator. <B>WARNING</B>: This method should only be
///     * invoked once from <seealso cref="IdGeneratorModule#start"/>. </summary>
///     * <param name="source">
///     *            the persistence source used for id generation </param>
///     
		internal virtual void configure(PersistenceSource source)
		{
		// Save connectivity
			this.persistenceSource = source;
		}

	// Accesor for persistence source
		private PersistenceSource getPersistenceSource()
		{
			return this.persistenceSource;
		}
	}
}